Skip to content

docs(actions): add workflow run status reference#44984

Closed
happysnaker wants to merge 1 commit into
github:mainfrom
happysnaker:docs/workflow-run-status-reference
Closed

docs(actions): add workflow run status reference#44984
happysnaker wants to merge 1 commit into
github:mainfrom
happysnaker:docs/workflow-run-status-reference

Conversation

@happysnaker

@happysnaker happysnaker commented Jun 30, 2026

Copy link
Copy Markdown

Why:

Closes: #34987

What's being changed (if available, include any code snippets, screenshots, or gifs):

This PR adds a dedicated Actions reference page for workflow run status and conclusion values, matching the approach requested in the issue discussion.

Changes in this PR:

  • add content/actions/reference/workflows-and-actions/workflow-run-statuses.md
  • add the new page to the Workflows and actions reference landing page
  • link the REST workflow runs page to the new reference so readers can understand the status filter values more easily

The new page distinguishes lifecycle status values from final conclusion values, and calls out two common sources of confusion:

  • pending is often caused by concurrency limits
  • waiting is often caused by deployment protection rules or required reviews

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Jun 30, 2026
@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/reference/workflows-and-actions/index.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
New file: actions/reference/workflows-and-actions/workflow-run-statuses.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
rest/actions/workflow-runs.md fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@happysnaker

happysnaker commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

This PR follows the direction requested in #34987: a dedicated reference-style article rather than a reusable snippet. I kept the scope small by documenting the workflow run lifecycle values, linking from the REST workflow-runs page, and calling out the two most confusing cases (pending from concurrency and waiting from deployment protection or required review).

@Sharra-writes

Sharra-writes commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

@happysnaker Hi, I'm willing to check in about the rest of this PR, but please don't alter our frontmatter formatting. We have it that way because it works for us and it will stop working for us if it's changed. Change that back, and I will get a review on the rest.

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code more-information-needed More information is needed to complete review Waiting on contributor and removed triage Do not begin working on this issue until triaged by the team labels Jul 9, 2026
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

This PR has been automatically closed because there has been no response to to our request for more information from the original author. Please reach out if you have the information we requested, or open an issue to describe your changes. Then we can reopen this PR and begin the review process.

@github-actions github-actions Bot closed this Jul 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

content This issue or pull request belongs to the Docs Content team github_actions Pull requests that update GitHub Actions code more-information-needed More information is needed to complete review Waiting on contributor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add missing documentation of use cases for workflowrun states

2 participants

@happysnaker @Sharra-writes